home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 July: Mac OS SDK / Dev.CD Jul 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Interfaces / AIncludes / Threads.a < prev    next >
Encoding:
Text File  |  1996-01-24  |  8.5 KB  |  391 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        Threads.a
  3. ;
  4. ;    Contains:    Thread Manager Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Package:    Universal Interfaces 2.2 in “MPW” on ETO #20
  8. ;
  9. ;    Copyright:    © 1984-1995 by Apple Computer, Inc.
  10. ;                All rights reserved.
  11. ;
  12. ;    Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13. ;                stack.  Include the file and version information (from above)
  14. ;                in the problem description and send to:
  15. ;                    Internet:    apple.bugs@applelink.apple.com
  16. ;                    AppleLink:    APPLE.BUGS
  17. ;
  18. ;
  19.  
  20.     IF &TYPE('__THREADS__') = 'UNDEFINED' THEN
  21. __THREADS__ SET 1
  22.  
  23.  
  24.     IF &TYPE('__ERRORS__') = 'UNDEFINED' THEN
  25.     include 'Errors.a'
  26.     ENDIF
  27. ;        include 'ConditionalMacros.a'                                ;
  28.  
  29.     IF &TYPE('__MEMORY__') = 'UNDEFINED' THEN
  30.     include 'Memory.a'
  31.     ENDIF
  32. ;        include 'Types.a'                                            ;
  33. ;        include 'MixedMode.a'                                        ;
  34. ; typedef unsigned short     ThreadState
  35.  
  36. kReadyThreadState                EQU        0
  37. kStoppedThreadState                EQU        1
  38. kRunningThreadState                EQU        2
  39.  
  40. ; Error codes have been meoved to Errors.(pah) 
  41. ; Thread environment characteristics 
  42. ; typedef void                 *ThreadTaskRef
  43. ; Thread characteristics 
  44. ; typedef unsigned long     ThreadStyle
  45.  
  46. kCooperativeThread                EQU        1 << 0
  47. kPreemptiveThread                EQU        1 << 1
  48.  
  49. ; Thread identifiers 
  50. ; typedef unsigned long     ThreadID
  51.  
  52. kNoThreadID                        EQU        0
  53. kCurrentThreadID                EQU        1
  54. kApplicationThreadID            EQU        2
  55.  
  56. ; Options when creating a thread 
  57. ; typedef unsigned long     ThreadOptions
  58.  
  59. kNewSuspend                        EQU        (1 << 0)
  60. kUsePremadeThread                EQU        (1 << 1)
  61. kCreateIfNeeded                    EQU        (1 << 2)
  62. kFPUNotNeeded                    EQU        (1 << 3)
  63. kExactMatchThread                EQU        (1 << 4)
  64.  
  65. ; Information supplied to the custom scheduler 
  66. SchedulerInfoRec         RECORD    0
  67. InfoRecSize                 ds.l   1        ; offset: $0 (0)
  68. CurrentThreadID             ds.l   1        ; offset: $4 (4)
  69. SuggestedThreadID         ds.l   1        ; offset: $8 (8)
  70. InterruptedCoopThreadID     ds.l   1        ; offset: $C (12)
  71. sizeof                     EQU *            ; size:   $10 (16)
  72.                         ENDR
  73.  
  74. ; typedef struct SchedulerInfoRec  SchedulerInfoRec
  75. ; typedef SchedulerInfoRec     *SchedulerInfoRecPtr
  76.     IF GENERATING68K  ** GENERATINGCFM  THEN
  77. ;
  78. ;    The following UniversalProcPtrs are for CFM-68k compatiblity with
  79. ;    the implementation of the Thread Manager.
  80. ;
  81. ; typedef UniversalProcPtr     ThreadEntryProcPtr
  82. ; typedef UniversalProcPtr     ThreadSchedulerProcPtr
  83. ; typedef UniversalProcPtr     ThreadSwitchProcPtr
  84. ; typedef UniversalProcPtr     ThreadTerminationProcPtr
  85. ; typedef UniversalProcPtr     DebuggerNewThreadProcPtr
  86. ; typedef UniversalProcPtr     DebuggerDisposeThreadProcPtr
  87. ; typedef UniversalProcPtr     DebuggerThreadSchedulerProcPtr
  88.     ELSE
  89. ;
  90. ;    The following ProcPtrs cannot be interchanged with UniversalProcPtrs because
  91. ;    of differences between 680x0 and PowerPC runtime architectures with regard to
  92. ;    the implementation of the Thread Manager.
  93. ; 
  94. ; Prototype for thread's entry (main) routine 
  95. ; typedef void                 *voidPtr
  96. ; Prototype for custom thread scheduler routine 
  97. ; Prototype for custom thread switcher routine 
  98. ; Prototype for thread termination notification routine 
  99. ; Prototype for debugger NewThread notification 
  100. ; Prototype for debugger DisposeThread notification 
  101. ; Prototype for debugger schedule notification 
  102.     ENDIF
  103. ;
  104. ; pascal OSErr CreateThreadPool(ThreadStyle threadStyle, short numToCreate, Size stackSize)
  105. ;
  106.     IF ¬ GENERATINGCFM THEN
  107.         Macro
  108.         _CreateThreadPool
  109.             move.w    #$0501,d0
  110.             dc.w     $ABF2
  111.         EndM
  112.     ELSE
  113.         IMPORT_CFM_FUNCTION    CreateThreadPool
  114.     ENDIF
  115.  
  116. ;
  117. ; pascal OSErr GetFreeThreadCount(ThreadStyle threadStyle, short *freeCount)
  118. ;
  119.     IF ¬ GENERATINGCFM THEN
  120.         Macro
  121.         _GetFreeThreadCount
  122.             move.w    #$0402,d0
  123.             dc.w     $ABF2
  124.         EndM
  125.     ELSE
  126.         IMPORT_CFM_FUNCTION    GetFreeThreadCount
  127.     ENDIF
  128.  
  129. ;
  130. ; pascal OSErr GetSpecificFreeThreadCount(ThreadStyle threadStyle, Size stackSize, short *freeCount)
  131. ;
  132.     IF ¬ GENERATINGCFM THEN
  133.         Macro
  134.         _GetSpecificFreeThreadCount
  135.             move.w    #$0615,d0
  136.             dc.w     $ABF2
  137.         EndM
  138.     ELSE
  139.         IMPORT_CFM_FUNCTION    GetSpecificFreeThreadCount
  140.     ENDIF
  141.  
  142. ;
  143. ; pascal OSErr GetDefaultThreadStackSize(ThreadStyle threadStyle, Size *stackSize)
  144. ;
  145.     IF ¬ GENERATINGCFM THEN
  146.         Macro
  147.         _GetDefaultThreadStackSize
  148.             move.w    #$0413,d0
  149.             dc.w     $ABF2
  150.         EndM
  151.     ELSE
  152.         IMPORT_CFM_FUNCTION    GetDefaultThreadStackSize
  153.     ENDIF
  154.  
  155. ;
  156. ; pascal OSErr ThreadCurrentStackSpace(ThreadID thread, unsigned long *freeStack)
  157. ;
  158.     IF ¬ GENERATINGCFM THEN
  159.         Macro
  160.         _ThreadCurrentStackSpace
  161.             move.w    #$0414,d0
  162.             dc.w     $ABF2
  163.         EndM
  164.     ELSE
  165.         IMPORT_CFM_FUNCTION    ThreadCurrentStackSpace
  166.     ENDIF
  167.  
  168. ;
  169. ; pascal OSErr NewThread(ThreadStyle threadStyle, ThreadEntryProcPtr threadEntry, void *threadParam, Size stackSize, ThreadOptions options, void **threadResult, ThreadID *threadMade)
  170. ;
  171.     IF ¬ GENERATINGCFM THEN
  172.         Macro
  173.         _NewThread
  174.             move.w    #$0E03,d0
  175.             dc.w     $ABF2
  176.         EndM
  177.     ELSE
  178.         IMPORT_CFM_FUNCTION    NewThread
  179.     ENDIF
  180.  
  181. ;
  182. ; pascal OSErr DisposeThread(ThreadID threadToDump, void *threadResult, Boolean recycleThread)
  183. ;
  184.     IF ¬ GENERATINGCFM THEN
  185.         Macro
  186.         _DisposeThread
  187.             move.w    #$0504,d0
  188.             dc.w     $ABF2
  189.         EndM
  190.     ELSE
  191.         IMPORT_CFM_FUNCTION    DisposeThread
  192.     ENDIF
  193.  
  194. ;
  195. ; pascal OSErr YieldToThread(ThreadID suggestedThread)
  196. ;
  197.     IF ¬ GENERATINGCFM THEN
  198.         Macro
  199.         _YieldToThread
  200.             move.w    #$0205,d0
  201.             dc.w     $ABF2
  202.         EndM
  203.     ELSE
  204.         IMPORT_CFM_FUNCTION    YieldToThread
  205.     ENDIF
  206.  
  207. ;
  208. ; pascal OSErr YieldToAnyThread(void)
  209. ;
  210.     IF ¬ GENERATINGCFM THEN
  211.         Macro
  212.         _YieldToAnyThread
  213.             dc.w     $42A7
  214.             move.w    #$0205,d0
  215.             dc.w     $ABF2
  216.         EndM
  217.     ELSE
  218.         IMPORT_CFM_FUNCTION    YieldToAnyThread
  219.     ENDIF
  220.  
  221. ;
  222. ; pascal OSErr GetCurrentThread(ThreadID *currentThreadID)
  223. ;
  224.     IF ¬ GENERATINGCFM THEN
  225.         Macro
  226.         _GetCurrentThread
  227.             move.w    #$0206,d0
  228.             dc.w     $ABF2
  229.         EndM
  230.     ELSE
  231.         IMPORT_CFM_FUNCTION    GetCurrentThread
  232.     ENDIF
  233.  
  234. ;
  235. ; pascal OSErr GetThreadState(ThreadID threadToGet, ThreadState *threadState)
  236. ;
  237.     IF ¬ GENERATINGCFM THEN
  238.         Macro
  239.         _GetThreadState
  240.             move.w    #$0407,d0
  241.             dc.w     $ABF2
  242.         EndM
  243.     ELSE
  244.         IMPORT_CFM_FUNCTION    GetThreadState
  245.     ENDIF
  246.  
  247. ;
  248. ; pascal OSErr SetThreadState(ThreadID threadToSet, ThreadState newState, ThreadID suggestedThread)
  249. ;
  250.     IF ¬ GENERATINGCFM THEN
  251.         Macro
  252.         _SetThreadState
  253.             move.w    #$0508,d0
  254.             dc.w     $ABF2
  255.         EndM
  256.     ELSE
  257.         IMPORT_CFM_FUNCTION    SetThreadState
  258.     ENDIF
  259.  
  260. ;
  261. ; pascal OSErr SetThreadStateEndCritical(ThreadID threadToSet, ThreadState newState, ThreadID suggestedThread)
  262. ;
  263.     IF ¬ GENERATINGCFM THEN
  264.         Macro
  265.         _SetThreadStateEndCritical
  266.             move.w    #$0512,d0
  267.             dc.w     $ABF2
  268.         EndM
  269.     ELSE
  270.         IMPORT_CFM_FUNCTION    SetThreadStateEndCritical
  271.     ENDIF
  272.  
  273. ;
  274. ; pascal OSErr SetThreadScheduler(ThreadSchedulerProcPtr threadScheduler)
  275. ;
  276.     IF ¬ GENERATINGCFM THEN
  277.         Macro
  278.         _SetThreadScheduler
  279.             move.w    #$0209,d0
  280.             dc.w     $ABF2
  281.         EndM
  282.     ELSE
  283.         IMPORT_CFM_FUNCTION    SetThreadScheduler
  284.     ENDIF
  285.  
  286. ;
  287. ; pascal OSErr SetThreadSwitcher(ThreadID thread, ThreadSwitchProcPtr threadSwitcher, void *switchProcParam, Boolean inOrOut)
  288. ;
  289.     IF ¬ GENERATINGCFM THEN
  290.         Macro
  291.         _SetThreadSwitcher
  292.             move.w    #$070A,d0
  293.             dc.w     $ABF2
  294.         EndM
  295.     ELSE
  296.         IMPORT_CFM_FUNCTION    SetThreadSwitcher
  297.     ENDIF
  298.  
  299. ;
  300. ; pascal OSErr SetThreadTerminator(ThreadID thread, ThreadTerminationProcPtr threadTerminator, void *terminationProcParam)
  301. ;
  302.     IF ¬ GENERATINGCFM THEN
  303.         Macro
  304.         _SetThreadTerminator
  305.             move.w    #$0611,d0
  306.             dc.w     $ABF2
  307.         EndM
  308.     ELSE
  309.         IMPORT_CFM_FUNCTION    SetThreadTerminator
  310.     ENDIF
  311.  
  312. ;
  313. ; pascal OSErr ThreadBeginCritical(void)
  314. ;
  315.     IF ¬ GENERATINGCFM THEN
  316.         Macro
  317.         _ThreadBeginCritical
  318.             move.w    #$000B,d0
  319.             dc.w     $ABF2
  320.         EndM
  321.     ELSE
  322.         IMPORT_CFM_FUNCTION    ThreadBeginCritical
  323.     ENDIF
  324.  
  325. ;
  326. ; pascal OSErr ThreadEndCritical(void)
  327. ;
  328.     IF ¬ GENERATINGCFM THEN
  329.         Macro
  330.         _ThreadEndCritical
  331.             move.w    #$000C,d0
  332.             dc.w     $ABF2
  333.         EndM
  334.     ELSE
  335.         IMPORT_CFM_FUNCTION    ThreadEndCritical
  336.     ENDIF
  337.  
  338. ;
  339. ; pascal OSErr SetDebuggerNotificationProcs(DebuggerNewThreadProcPtr notifyNewThread, DebuggerDisposeThreadProcPtr notifyDisposeThread, DebuggerThreadSchedulerProcPtr notifyThreadScheduler)
  340. ;
  341.     IF ¬ GENERATINGCFM THEN
  342.         Macro
  343.         _SetDebuggerNotificationProcs
  344.             move.w    #$060D,d0
  345.             dc.w     $ABF2
  346.         EndM
  347.     ELSE
  348.         IMPORT_CFM_FUNCTION    SetDebuggerNotificationProcs
  349.     ENDIF
  350.  
  351. ;
  352. ; pascal OSErr GetThreadCurrentTaskRef(ThreadTaskRef *threadTRef)
  353. ;
  354.     IF ¬ GENERATINGCFM THEN
  355.         Macro
  356.         _GetThreadCurrentTaskRef
  357.             move.w    #$020E,d0
  358.             dc.w     $ABF2
  359.         EndM
  360.     ELSE
  361.         IMPORT_CFM_FUNCTION    GetThreadCurrentTaskRef
  362.     ENDIF
  363.  
  364. ;
  365. ; pascal OSErr GetThreadStateGivenTaskRef(ThreadTaskRef threadTRef, ThreadID threadToGet, ThreadState *threadState)
  366. ;
  367.     IF ¬ GENERATINGCFM THEN
  368.         Macro
  369.         _GetThreadStateGivenTaskRef
  370.             move.w    #$060F,d0
  371.             dc.w     $ABF2
  372.         EndM
  373.     ELSE
  374.         IMPORT_CFM_FUNCTION    GetThreadStateGivenTaskRef
  375.     ENDIF
  376.  
  377. ;
  378. ; pascal OSErr SetThreadReadyGivenTaskRef(ThreadTaskRef threadTRef, ThreadID threadToSet)
  379. ;
  380.     IF ¬ GENERATINGCFM THEN
  381.         Macro
  382.         _SetThreadReadyGivenTaskRef
  383.             move.w    #$0410,d0
  384.             dc.w     $ABF2
  385.         EndM
  386.     ELSE
  387.         IMPORT_CFM_FUNCTION    SetThreadReadyGivenTaskRef
  388.     ENDIF
  389.  
  390.     ENDIF ; __THREADS__
  391.